Conversation
bnbong
added
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates developer tooling/docs so local pre-commit hooks no longer depend on system-installed formatters/linters, and moves template-change inspection feedback into a PR-triggered GitHub Actions workflow (aligning with issue #38).
Changes:
- Refactors
.pre-commit-config.yamlto run Black/Isort/Mypy vialanguage: pythonhook envs (no morelanguage: systemscripts). - Adds “Template PR Inspection” GitHub Actions workflow to validate changed templates and comment results on PRs.
- Updates contributing/development documentation to reflect the revised workflows and commands.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
env.example |
Simplifies translation env example; removes optional token/provider notes. |
docs/en/contributing/template-creation-guide.md |
Documents that template PRs are automatically inspected via CI. |
docs/en/contributing/development-setup.md |
Updates dev setup and pre-commit guidance; adds env var notes. |
docs/en/contributing/code-guidelines.md |
Updates documented pre-commit configuration example and removes flake8 mention. |
CONTRIBUTING.md |
Adds CI template inspection description; updates pre-commit checklist. |
.pre-commit-config.yaml |
Reworks hooks to use isolated Python environments with tool deps. |
.github/workflows/template-pr-inspection.yml |
New PR workflow that inspects changed templates and comments results. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requesting Merging
Description
edit pre-commit hooks & update FastAPI-fastkit dev guides to current version
Type of Change
Test Environment
local, M1 Mac, Windows 11
Major Changes
fastapi_project_templateScreenshots (optional)
N/A
Etc
close #38